CiscoXaaSAPI

1.0.x
(0 reviews)

Attribute Index

This Page provides description of each attribute in Response and Request Calls for all of the service calls.


NOTE: Please note that some attributes may have different requirements depending on the call.

No.CardinalityElementAttribute TypeFormatElement PathAPI CallCall TypeExampleDescription
11uuidstring/subscription/cancelPOSTuuid: Q1FY17SubscriptionTestUnique ID for the Transaction
1/subscription/statusGET
1/subscriptionPUT
1/subscription/cancelPOST
1/subscription/statusGET
1/provisioning/validatePOST
1/subscriptionPOST
21createdBystring/provisioning/validatePOSTcreatedBy: user_idUser ID who created Order on Customer Marketplace. Not stored or used by Cisco
1/subscription/cancelPOST
1/subscriptionPOST
1/subscriptionPUT
31createdDateTimestringDate-Time/provisioning/validatePOSTcreatedDateTime: 2013-05-23T13:23:42-06:00Time of Order Creation
1/subscription/cancelPOST
1/subscriptionPOST
1/subscriptionPUT
40..1csbOrderIdstring/provisioning/validatePOSTcsbOrderId: csb-123123123Cloud Service Broker Order Identifier for the Subscription
0..1/subscription/cancelPOST
0..1/subscription/statusGET
0..1/subscriptionPOST
0..1/subscriptionPUT
51csbSubscriptionIdstring/provisioning/validatePOSTcsbSubscriptionId: csb-123456Cloud Service Broker Subscription Identifier for the Subscription
1/subscription/cancelPOST
1/subscription/statusGET
1/subscriptionPOST
1/subscriptionPUT
61billingAddressIDnumber/provisioning/validatePOSTbillingAddressID: 123123123123Site use ID of a billing address
1/subscription/cancelPOST
1/subscriptionPOST
1/subscriptionPUT
71..nbillingAddressNamestring/provisioning/validatePOSTbillingAddressName: 123 Pear StreetStreet Address for Customer
0..1/subscriptionPUT
0..1/subscriptionPOST
81currencystring/provisioning/validatePOSTcurrency: USDISO Currency code for country
1/subscriptionPOST
1/subscriptionPUT
91..npaymentMethodstring/provisioning/validatePOSTpaymentMethod: NET30Type of Payment to be used.
0..1/subscriptionPOST
0..1/subscriptionPUT
101purchaseOrderNumberstring/provisioning/validatePOSTpurchaseOrderNumber: PO123123Purchase Order Number
0..1/subscription/cancelPOST
1/subscriptionPOST
1/subscriptionPUT
110..1rejectDuplicatePOstring/provisioning/validatePOSTrejectDuplicatePO: NUser preference to reject order if PO number is used more than once
0..1/subscriptionPOST
0..1/subscriptionPUT
120..1governmentOrderstring/provisioning/validatePOSTgovernmentOrder: NIs Order for Federal Government
0..1/subscriptionPOST
130..1intendedUsestring/provisioning/validatePOSTintendedUse: ResaleIdentifies the purpose of the order
0..1/subscriptionPOST
141intialTermnumber/provisioning/validatePOSTintialTerm: 28Initial Term of Subscription
1/subscriptionPOST
1/subscriptionPUT
151autoRenewalTermnumber/provisioning/validatePOSTautoRenewalTerm: 3How long the duration will renewed for after initial term
0..1/subscription/statusGET
1/subscriptionPOST
1/subscriptionPUT
161billingModelstring/provisioning/validatePOSTbillingModel: Monthly BillingCustomer Preference for Billing
1/subscriptionPOST
1/subscriptionPUT
170..1trueUpTermnumber/provisioning/validatePOSTtrueUpTerm: 24Committed term for True up SKUs
0..1/subscriptionPUT
0..1/subscriptionPOST
181requestedStartDatestringDate-Only/provisioning/validatePOSTrequestedStartDate: 2017-01-23Requested To-Be Start Date of Subscription
1/subscriptionPOST
1/subscriptionPUT
190..1trialAccountIdstring/provisioning/validatePOSTtrialAccountId: 1234-5678-90This will be all numbers in ####-####-## format, can be obtained from Duo trial account page
0..1/subscriptionPOST
201partiesarray/provisioning/validatePOSTparties: { }Array for Party Information
1..n/subscriptionPOST
211..npartyNamestringpartiesOf(n).partyName/provisioning/validatePOSTpartyName: Reseller_NameName of Party
1..n/subscriptionPOST
220..npartyIdentifiernumberpartiesOf(n).partyIdentifier/provisioning/validatePOSTpartyIdentifier: 1000Identifier for the Party
0..n/subscriptionPOST
231..npartyTypestringpartiesOf(n).partyType/provisioning/validatePOSTpartyType: ResellerParty Type
241..naddressLine1stringpartiesOf(n).addressLine1/provisioning/validatePOSTaddressLine1: 123 Apple Street"Address Line 1"
1..n/subscriptionPOST
250..naddressLine2stringpartiesOf(n).addressLine2/provisioning/validatePOSTaddressLine2: Suite Number 4Address Line 2. Additional Information for Address of Customer/Party
0..n/subscriptionPOST
260..naddressLine3stringpartiesOf(n).addressLine3/provisioning/validatePOSTaddressLine3: AddressLine3Address Line 3. Additional Information for Address of Customer/Party
0..n/subscriptionPOST
271..ncitystringpartiesOf(n).city/provisioning/validatePOSTcity: San FranciscoParty City Location
1..n/subscriptionPOST
281..nstatestringpartiesOf(n).state/provisioning/validatePOSTstate: New YorkParty State Location
1..n/subscriptionPOST
291..npostalCodestringpartiesOf(n).postalCode/provisioning/validatePOSTpostalCode: Postal_Code_herePostal Code of Party Address
1..n/subscriptionPOST
301..ncountrystringpartiesOf(n).country/provisioning/validatePOSTcountry: USISO Country Code of Party Contact
1..n/subscriptionPOST
311..nbusinessContactEmailstringpartiesOf(n).businessContactEmail/provisioning/validatePOSTbusinessContactEmail: business_contact_email@email.comEmail Address of Party Contact
1..n/subscriptionPOST
321..nbusinessContactNamestringpartiesOf(n).businessContactName/provisioning/validatePOSTbusinessContactName: contact_name_hereName of Party Contact
1..n/subscriptionPOST
331..nbusinessContactTelephonestringpartiesOf(n).businessContactTelephone/provisioning/validatePOSTbusinessContactTelephone: 123-123-1234Phone Number of Party Contact
1..n/subscriptionPOST
340..1accountNumberstringpartiesOf(n).accountNumber/provisioning/validatePOSTaccountNumber: 123Account Number associated with Party (This is not mandatory in case of Transacting Reseller scenario).
0..1/subscriptionPOST
351offersarray/provisioning/validatePOSToffers: { }Array for Offer Details
1..n/subscriptionPOST
1/subscriptionPUT
361lineNumbernumberoffersOf(n).lineNumber/provisioning/validatePOSTlineNumber: 1Line Number
1/subscriptionPOST
1/subscriptionPUT
371offerSKUstringoffersOf(n).offerSKU/provisioning/validatePOSTofferSKU: A-SPK-NU-C1Subscription Offer. Required if no csbCiscoKey provided
1/subscriptionPOST
1/subscriptionPUT
381offerATOstringoffersOf(n).offerATO/provisioning/validatePOSTofferATO: A-SPK-NAMED-USROverlying major which holds minors. Required if no csbCiscoKey provided
1/subscriptionPOST
1/subscriptionPUT
391quantityintegeroffersOf(n).quantity/provisioning/validatePOSTquantity: 1Quantity being Ordered.
1/subscriptionPOST
1/subscriptionPUT
401csbCiscoKeystringoffersOf(n).lineNumber/subscriptionPOSTcsbCiscoKey: 12312312391238123Cloud Service Broker Cisco Key for the Subscription. Required if no Offer ATO & Offer SKU provided
1/subscriptionPUT
411provisioningAttributesarrayOffersOf(n).ProvisioningAttributes/provisioning/validatePOSTprovisioningAttributes: { }Array for Provisioning Details
0..1/subscriptionPOST
0..1/subscriptionPUT
421..nattributeIdentifierstringOffersOf(n).provisioningAttributesOf(n).attributeIdentifier/provisioning/validatePOSTattributeIdentifier: 11120393234Identifier for an individual provisioning detail attribute.
0..n/subscriptionPOST
0..n/subscriptionPUT
431..nattributeNamestringOffersOf(n).provisioningAttributesOf(n).attributeName/provisioning/validatePOSTattributeName: Common.Contacts.ORGANIZATION NAMEName of provisioning attribute
0..n/subscriptionPOST
0..n/subscriptionPUT
441..nattributeValuestringOffersOf(n).provisioningAttributesOf(n).attributeValue/provisioning/validatePOSTattributeValue: Random_Organization_NameValue of Provisioning Attribute.
0..n/subscriptionPOST
0..n/subscriptionPUT
451tncacceptancestring/provisioning/validatePOSTtncacceptance: YTerms and Conditions Acknowledgment
1/subscriptionPOST
1/subscriptionPUT
460..1autoRenewalstring/subscription/statusGETautoRenewal: NIf Order will be renewed after Initial Term
471cancelCodestring/subscription/cancelPOSTcancelCode: 20~Adoption~Lack of DocumentationCode associated to a cancel reason
481cancelReasonstring/subscription/cancelPOSTcancelReason: Insert_Cancellation_Reason_hereReason for cancelling exisiting Subscription order
491identifierstring/subscription/cancelPOSTidentifier: 23923923Identifier for Cancellation case
501identifierTypestring/subscription/cancelPOSTidentifierType: CISCO_CASEDescription of Cancellation Case Identifier
511statusCodestring/subscription/cancelPOSTstatusCode: ACTIVECurrent Status of Subscription.
0..1/provisioning/validatePOST
1/subscriptionPUT
0..1/subscription/statusGET
1/subscriptionPOST
521statusstring/provisioning/validatePOSTstatus: Status_message_based_on_statusCodeLong Description of status based on value of the status Code.
1/subscriptionPUT
1/subscription/cancelPOST
1/subscriptionPOST
0..1/subscription/statusGET
531subscriptionIdstring/subscriptionPUTsubscriptionId: Sub83823Identifier for a valid distinct Subscription
540..1subscriptionStartDatestringDate-Only/subscription/statusGETsubscriptionStartDate: 2017-11-08Start Date of already existing Subscription
0..1/subscriptionPUT
550..1subscriptionEndDatestringDate-Only/subscription/statusGETsubscrptionEndDate: 2018-11-08End Date of an already existing Subscription
0..1/subscriptionPUT
561webOrderIdstring/subscription/statusGETwebOrderId: 123123Cisco identifier for a Subscription Order
1/subscriptionPUT
1/subscriptionPOST
571errorsarray/provisioning/validatePOSTerrors: { }Array for Error information
580..nerrorAttributestringerrorsOf(n).errorAttribute/provisioning/validatePOSTerrorAttribute: billingModelIdentifier for an Error Attribute
0..n/subscriptionPOST
0..n/subscriptionPUT
590..nerrorAttributeValuestringerrorsOf(n).errorAttributeValue/provisioning/validatePOSTerrorAttributeValue: BiannuallyValue of the Error Attribute
0..n/subscriptionPOST
0..n/subscriptionPUT
601..nerrorCodestringerrorsOf(n).errorCode/provisioning/validatePOSTerrorCode: CISCO_ERRORIdentifier for Error Code
1..n/subscriptionPOST
1..n/subscriptionPUT
0..1/subscription/statusGET
611..nerrorMessagestringerrorsOf(n).errorMessage/provisioning/validatePOST"errorMessage: There seems to an issue at our end. For assistance please contact Cisco Support. CS470 Subscription configuration is not valid. Select 'Change/Select Options' to remove or correct the options."""Description of Error Code
1..n/subscriptionPOST
1..n/subscriptionPUT
0..1/subscription/statusGET
620..1provisioningReferenceIdstring/provisioning/validatePOST"provisioningReferenceId": 3232323Reference Identifier for Successful Provisioning

Reviews